/**
 * Copyright (c) 2011 eelpo.com
 * All rights reserved.
 */
package com.eelpo.cmmp.uac.dao;

import java.util.List;

import com.eelpo.cmmp.uac.dao.entity.TRole;
import com.eelpo.cmmp.uac.dao.vo.Role;

import org.springframework.dao.DataAccessException;

/**
 * <pre>
 * 
 * 角色数据持久层接口定义
 * 
 * </pre>
 * 
 * @author <a href="mailto:Brian@eelpo.com">汪洪州</a>
 * @since 1.0
 */
public interface IRoleManageDao {

	/**
	 * 根据角色Id获取角色对象
	 * 
	 * @param id
	 *            角色ID
	 * @return 返回角色值对象
	 * @throws DataAccessException
	 *             抛出数据访问异常
	 */
	public TRole getRoleById(String id) throws DataAccessException;

	/**
	 * 检查角色名是否已经存在
	 * 
	 * @param name
	 *            角色名
	 * @return 返回布尔值，true表示已经存在，false表示不存在
	 * @throws DataAccessException
	 *             抛出数据访问异常
	 */
	public boolean checkExist(String name) throws DataAccessException;

	/**
	 * 检查角色名是否已经存在，用于修改角色
	 * 
	 * @param id
	 *            角色Id
	 * @param name
	 *            角色名
	 * @return 返回布尔值，true表示已经存在，false表示不存在
	 * @throws DataAccessException
	 *             抛出数据访问异常
	 */
	public boolean checkExistByUpdate(String id, String name) throws DataAccessException;

	/**
	 * 检查角色是否已经被使用
	 * 
	 * @param id
	 *            角色id
	 * @return 返回布尔值，true表示已经使用，false表示没被使用
	 * @throws DataAccessException
	 *             抛出数据访问异常
	 */
	public boolean checkRoleUsed(String id) throws DataAccessException;

	/**
	 * 新增角色
	 * 
	 * @param role
	 *            角色对象
	 * @return 返回新增过的角色Id
	 * @throws DataAccessException
	 *             抛出数据访问异常
	 */
	public String addRole(TRole role) throws DataAccessException;

	/**
	 * 修改角色
	 * 
	 * @param role
	 *            角色对象
	 * @throws DataAccessException
	 *             抛出数据访问异常
	 */
	public void updateRole(TRole role) throws DataAccessException;

	/**
	 * 根据Id删除角色
	 * 
	 * @param id
	 *            角色Id
	 * @throws DataAccessException
	 *             抛出数据访问异常
	 */
	public void deleteRole(String id) throws DataAccessException;

	/**
	 * 根据参数获取角色分页列表
	 * 
	 * @param role
	 *            角色参数
	 * @param first
	 *            分页起始条数
	 * @param max
	 *            分页获取的单页条数
	 * @return 返回角色分页列表
	 * @throws DataAccessException
	 *             抛出数据访问异常
	 */
	public List<TRole> getRolesPaing(Role role, final int first, final int max) throws DataAccessException;

	/**
	 * 根据参数获取角色分页列表
	 * 
	 * @param userId
	 *            登录用户的ID
	 * @param role
	 *            角色参数
	 * @param first
	 *            分页起始条数
	 * @param max
	 *            分页获取的单页条数
	 * @return 返回角色分页列表
	 * @throws DataAccessException
	 *             抛出数据访问异常
	 */
	public List<TRole> getRolesPaing(String userId, Role role, final int first, final int max) throws DataAccessException;

	/**
	 * 根据参数获取角色数量
	 * 
	 * @param role
	 *            角色参数
	 * @return 返回角色数量
	 * @throws DataAccessException
	 *             抛出数据访问异常
	 */
	public int getRolesCount(Role role) throws DataAccessException;

	/**
	 * 根据参数获取角色数量
	 * 
	 * @param userId
	 *            登录用户的ID
	 * @param role
	 *            角色参数
	 * @return 返回角色数量
	 * @throws DataAccessException
	 *             抛出数据访问异常
	 */
	public int getRolesCount(String userId, Role role) throws DataAccessException;
}
